Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 66 additions & 2 deletions lib/services/android-project-service.ts
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,14 @@ import {
} from "../definitions/gradle";
import { IInjector } from "../common/definitions/yok";
import { injector } from "../common/yok";
import { IProjectChangesInfo } from "../definitions/project-changes";
import {
DEV_CLEARTEXT_MARKER,
devCleartextManifest,
hasDevCleartext,
needsDevCleartext,
withDevCleartext,
} from "./android/dev-cleartext-manifest";
import { INotConfiguredEnvOptions } from "../common/definitions/commands";

interface NativeDependency {
Expand Down Expand Up @@ -845,8 +853,64 @@ export class AndroidProjectService
await adb.executeShellCommand(["rm", "-rf", deviceRootPath]);
}

public async checkForChanges(): Promise<void> {
// Nothing android specific to check yet.
public async checkForChanges(
changesInfo: IProjectChangesInfo,
prepareData: IPrepareData,
projectData: IProjectData,
): Promise<void> {
// Native prepare skips `prepareDevServerAccess` for a host project.
if (this.$options.hostProjectPath) {
return;
}
const manifestPath = this.getDebugManifestPath(projectData);
const current = this.$fs.exists(manifestPath)
? this.$fs.readText(manifestPath)
: null;
// The build is what carries the permission, so a change has to rebuild.
if (
needsDevCleartext(projectData, prepareData) !== hasDevCleartext(current)
) {
changesInfo.appResourcesChanged = true;
}
}

/**
* Lets a Vite HMR debug build fetch its code from the dev server over
* plain HTTP, through the debug source set's manifest in the native
* project. Runs after `prepareAppResources`, which restores the app's own
* debug manifest, if any, from App_Resources.
*/
public prepareDevServerAccess(
projectData: IProjectData,
prepareData: IPrepareData,
): void {
const manifestPath = this.getDebugManifestPath(projectData);
const current = this.$fs.exists(manifestPath)
? this.$fs.readText(manifestPath)
: null;
if (!needsDevCleartext(projectData, prepareData)) {
if (current !== null && current.includes(DEV_CLEARTEXT_MARKER)) {
this.$fs.deleteFile(manifestPath);
}
return;
}
if (hasDevCleartext(current)) {
return;
}
this.$fs.writeFile(
manifestPath,
current === null ? devCleartextManifest() : withDevCleartext(current),
);
}

private getDebugManifestPath(projectData: IProjectData): string {
return path.join(
this.getPlatformData(projectData).projectRoot,
this.$options.hostProjectModuleName,
constants.SRC_DIR,
"debug",
constants.MANIFEST_FILE_NAME,
);
}

public getDeploymentTarget(projectData: IProjectData): semver.SemVer {
Expand Down
99 changes: 99 additions & 0 deletions lib/services/android/dev-cleartext-manifest.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
import { IProjectData } from "../../definitions/project";

/**
* Identifies a debug manifest whose cleartext permission the CLI wrote, so a
* later prepare that doesn't need it can take it out again.
*/
export const DEV_CLEARTEXT_MARKER =
"nativescript-cli: cleartext HTTP to the Vite dev server (debug HMR runs only)";

const TOOLS_NS = 'xmlns:tools="http://schemas.android.com/tools"';
const CLEARTEXT_ATTRIBUTE = "android:usesCleartextTraffic";

/**
* A Vite HMR app loads its code from the dev server over plain HTTP, which
* Android blocks by default from API 28.
*/
export function needsDevCleartext(
projectData: Pick<IProjectData, "bundler">,
prepareData: { hmr?: boolean; release?: boolean },
): boolean {
return (
projectData.bundler === "vite" && !!prepareData.hmr && !prepareData.release
);
}

export function hasDevCleartext(manifest: string | null): boolean {
return !!manifest && manifest.includes(DEV_CLEARTEXT_MARKER);
}

/** The debug source set's manifest when the app ships none of its own. */
export function devCleartextManifest(): string {
return [
'<?xml version="1.0" encoding="utf-8"?>',
`<!-- ${DEV_CLEARTEXT_MARKER} -->`,
`<manifest xmlns:android="http://schemas.android.com/apk/res/android" ${TOOLS_NS}>`,
`\t<application ${CLEARTEXT_ATTRIBUTE}="true" tools:replace="${CLEARTEXT_ATTRIBUTE}" />`,
"</manifest>",
"",
].join("\n");
}

/**
* The app's own debug manifest with the permission added. `tools:replace`
* lets it win over a main manifest that sets the attribute itself.
*/
export function withDevCleartext(manifest: string): string {
let result = manifest;
const manifestTag = /<manifest\b[^>]*>/.exec(result);
if (!manifestTag) {
return result;
}
if (!manifestTag[0].includes("xmlns:tools=")) {
const withTools = manifestTag[0].replace(
/^<manifest\b/,
`<manifest ${TOOLS_NS}`,
);
result = result.replace(manifestTag[0], withTools);
}

const applicationTag = /<application\b[^>]*?(\/?)>/.exec(result);
if (!applicationTag) {
result = result.replace(
/<\/manifest>/,
`\t<application ${CLEARTEXT_ATTRIBUTE}="true" tools:replace="${CLEARTEXT_ATTRIBUTE}" />\n</manifest>`,
);
} else {
let tag = applicationTag[0];
const value = new RegExp(`${CLEARTEXT_ATTRIBUTE}\\s*=\\s*"[^"]*"`);
tag = value.test(tag)
? tag.replace(value, `${CLEARTEXT_ATTRIBUTE}="true"`)
: tag.replace(
/^<application\b/,
`<application ${CLEARTEXT_ATTRIBUTE}="true"`,
);
const replace = /tools:replace\s*=\s*"([^"]*)"/.exec(tag);
if (!replace) {
tag = tag.replace(
/^<application\b/,
`<application tools:replace="${CLEARTEXT_ATTRIBUTE}"`,
);
} else if (
!replace[1]
.split(",")
.map((name) => name.trim())
.includes(CLEARTEXT_ATTRIBUTE)
) {
tag = tag.replace(
replace[0],
`tools:replace="${replace[1]},${CLEARTEXT_ATTRIBUTE}"`,
);
}
result = result.replace(applicationTag[0], tag);
}

return result.replace(
/(<manifest\b)/,
`<!-- ${DEV_CLEARTEXT_MARKER} -->\n$1`,
);
}
Loading
Loading