Connectors for version v5.0.3

Author: actions-user

edgio-angular-connector/.gitignore

@@ -0,0 +1,2 @@
+/stage
+!test/app/dist

edgio-angular-connector/README.md

@@ -0,0 +1,3 @@
+# @edgio/angular
+
+Run server-side rendered Angular apps on the [Edgio](https://docs.edg.io).

edgio-angular-connector/babel.config.js

@@ -0,0 +1,12 @@
+module.exports = {
+  presets: [
+    [
+      '@babel/preset-env',
+      {
+        targets: {
+          node: '14', // NODE_VERSION
+        },
+      },
+    ],
+  ],
+}

edgio-angular-connector/default-app/all/edgio.config.js

@@ -0,0 +1,62 @@
+// This file was automatically added by edgio init.
+// You should commit this file to source control.
+// Learn more about this file at https://docs.edg.io/guides/edgio_config
+module.exports = {
+  connector: '@edgio/angular',
+
+  // The name of the site in Edgio to which this app should be deployed.
+  // name: 'my-site-name',
+
+  // The name of the team in Edgio to which this app should be deployed.
+  // team: 'my-team-name',
+
+  // backends: {
+  //   origin: {
+  //     // The domain name or IP address of the origin server
+  //     domainOrIp: 'example.com',
+  //
+  //     // When provided, the following value will be sent as the host header when connecting to the origin.
+  //     // If omitted, the host header from the browser will be forwarded to the origin.
+  //     hostHeader: 'example.com',
+  //
+  //     // Uncomment the following line if TLS is not set up properly on the origin domain and you want to ignore TLS errors
+  //     // disableCheckCert: true,
+  //
+  //     // Overrides the default ports (80 for http and 443 for https) and instead use a specific port
+  //     // when connecting to the origin
+  //     // port: 1337,
+  //   },
+  // },
+
+  // Overrides the default path to the routes file. The path should be relative to the root of your app.
+  // routes: 'routes.js',
+
+  // The maximum number of URLs that will be concurrently prerendered during deployment when static prerendering is enabled.
+  // Defaults to 200, which is the maximum allowed value.
+  // prerenderConcurrency: 200,
+
+  // A list of glob patterns identifying which source files should be uploaded when running edgio deploy --includeSources.
+  // This option is primarily used to share source code with Edgio support personnel for the purpose of debugging. If omitted,
+  // edgio deploy --includeSources will result in all files which are not gitignored being uploaded to Edgio.
+  //
+  // sources : [
+  //   '**/*', // include all files
+  //   '!(**/secrets/**/*)', // except everything in the secrets directory
+  // ],
+
+  // Allows you to include additional resources in the bundle that is deployed to Edgio’s serverless JS workers.
+  // Keys are globs, value can be a boolean or string. This is typically used to ensure that resources
+  // that need to be dynamically required at runtime such as build manifests for server-side rendering
+  // or other config files are present in the cloud.
+  //
+  // includeFiles: {
+  //   'lang/**/*': true, // Just includes the specified files
+  //   'content/**/*': 'another/dir/in/edgio/lambda', // Copies the files into specific directory within Edgio build
+  // },
+
+  // Set to true to include all packages listed in the dependencies property of package.json when deploying to Edgio.
+  // This option generally isn't needed as Edgio automatically includes all modules imported by your code in the bundle that
+  // is uploaded during deployment
+  //
+  // includeNodeModules: true,
+}

edgio-angular-connector/default-app/all/routes.js

@@ -0,0 +1,10 @@
+// This file was automatically added by edgio deploy.
+// You should commit this file to source control.
+
+const { Router } = require('@edgio/core/router')
+const { angularRoutes } = require('@edgio/angular')
+
+module.exports = new Router()
+  // Prevent search engines from indexing permalink URLs
+  .noIndexPermalink()
+  .use(angularRoutes)

edgio-angular-connector/package-lock.json

@@ -0,0 +1,59 @@
+{
+  "name": "@edgio/angular",
+  "version": "5.0.3",
+  "license": "Apache-2.0",
+  "edgio-publish-to-repo": "edgio-docs/edgio-connectors",
+  "peerDependencies": {
+    "@edgio/core": "^5.0.0"
+  },
+  "devDependencies": {
+    "@edgio/core": "^5.0.3",
+    "@types/cross-spawn": "^6.0.2"
+  },
+  "scripts": {
+    "build": "rm -rf ./dist; mkdir ./dist; cp -r package.json README.md default-app ./dist; tsc; cp -r stage/angular/src/* dist;",
+    "watch": "npm-watch",
+    "push-build": "npm run build && cd dist && yalc push && cd ..",
+    "release": "npm run build; cd ./dist; npm publish --access public",
+    "release:next": "npm run release -- --tag next",
+    "test": "jest"
+  },
+  "watch": {
+    "push-build": {
+      "patterns": [
+        "src",
+        "package.json",
+        "default-app"
+      ],
+      "extensions": "*",
+      "quiet": false
+    }
+  },
+  "jest": {
+    "clearMocks": true,
+    "collectCoverage": true,
+    "transform": {
+      "^.+\\.(js)?$": "babel-jest",
+      "^.+\\.ts$": "ts-jest"
+    },
+    "moduleFileExtensions": [
+      "ts",
+      "js",
+      "json"
+    ],
+    "transformIgnorePatterns": [
+      "<rootDir>/node_modules/"
+    ],
+    "collectCoverageFrom": [
+      "./src/router/**/*.ts",
+      "!**/index.ts"
+    ],
+    "moduleNameMapper": {
+      "^@edgio/core(.*)$": "<rootDir>/../core/dist/$1",
+      "^@edgio/angular(.*)$": "<rootDir>/../angular/src/$1"
+    }
+  },
+  "publishConfig": {
+    "directory": "dist"
+  }
+}

edgio-angular-connector/package.json

@@ -0,0 +1,53 @@
+import { getOutputPath } from './utils/getBuildPath'
+import { read as readPackageJson } from '@edgio/core/utils/packageUtils'
+import FrameworkBuildError from '@edgio/core/errors/FrameworkBuildError'
+import { join } from 'path'
+import { DeploymentBuilder, BuildOptions } from '@edgio/core/deploy'
+
+const appDir = process.cwd()
+const distDir = join(appDir, 'dist')
+const builder = new DeploymentBuilder(appDir)
+
+export default async function build({ skipFramework }: BuildOptions) {
+  builder.clearPreviousBuildOutput()
+
+  const pkg = readPackageJson()
+  const isSsr = pkg.scripts['build:ssr']
+
+  if (!skipFramework) {
+    const command = `npm run build${isSsr ? ':ssr' : ''}`
+
+    // clear dist directory
+    builder.emptyDirSync(distDir)
+
+    try {
+      // run the build command
+      await builder.exec(command)
+    } catch (e) {
+      throw new FrameworkBuildError('Angular', command, e)
+    }
+  }
+
+  const assetsPath = getOutputPath('build')
+  const serverPath = getOutputPath('server')
+
+  // if this is an SSR build, add the server to the bundle
+  if (serverPath) {
+    // Include the angular server which is loaded by the prod entrypoint
+    builder.addJSAsset(
+      join(appDir, serverPath, 'main.js'),
+      join('__backends__', 'angular-server.js')
+    )
+  }
+
+  builder
+    // angular.json
+    .addJSAsset(join(appDir, 'angular.json'), 'angular.json')
+    // browser assets
+    .addStaticAsset(join(appDir, assetsPath), '/')
+    // Index html required by Universal engine
+    .addJSAsset(join(appDir, assetsPath, 'index.html'), join('/', assetsPath, 'index.html'))
+
+  // exclude the prod handler if we're building only static (no SSR)
+  await builder.build({ excludeProdEntryPoint: !serverPath })
+}

edgio-angular-connector/src/build.ts

@@ -0,0 +1,13 @@
+/* istanbul ignore file */
+import createDevServer from '@edgio/core/dev/createDevServer'
+
+export default async function dev() {
+  return createDevServer({
+    label: 'Angular',
+    command: port => `npx ng serve --port ${port}`,
+    ready: [/compiled successfully/i],
+    filterOutput: line => {
+      return line.match(/\w/) && !line.match(/listening on/i) ? true : false
+    },
+  })
+}

edgio-angular-connector/src/dev.ts

@@ -0,0 +1 @@
+export * from './router'

edgio-angular-connector/src/index.ts

@@ -0,0 +1,12 @@
+import { join } from 'path'
+import { DeploymentBuilder } from '@edgio/core/deploy'
+
+/**
+ * Adds all required dependencies and files to the user's app by copying them
+ * over from src/default-app.
+ */
+module.exports = function init() {
+  new DeploymentBuilder(process.cwd())
+    .addDefaultAppResources(join(__dirname, 'default-app'))
+    .addDefaultEdgioScripts()
+}

edgio-angular-connector/src/init.ts

@@ -0,0 +1,10 @@
+/* istanbul ignore file */
+export default async function prod(port: number) {
+  return new Promise((resolve, reject) => {
+    try {
+      require('./angular-server').app().listen(port, resolve)
+    } catch (e) {
+      reject(e)
+    }
+  })
+}

edgio-angular-connector/src/prod.ts

@@ -0,0 +1,59 @@
+import { BACKENDS } from '@edgio/core/constants'
+import PluginBase from '@edgio/core/plugins/PluginBase'
+import { Router } from '@edgio/core/router'
+import { getBuildPath, getOutputPath } from '../utils/getBuildPath'
+
+/**
+ * A TTL for assets that never change.  10 years in seconds.
+ */
+const FAR_FUTURE_TTL = 60 * 60 * 24 * 365 * 10
+
+const PUBLIC_CACHE_CONFIG = {
+  edge: {
+    maxAgeSeconds: FAR_FUTURE_TTL,
+  },
+}
+
+export default class AngularRoutes extends PluginBase {
+  angularRouteGroupName = 'angular_routes_group'
+
+  /**
+   * Called when plugin is registered
+   * @private
+   * @param router
+   */
+  onRegister(router: Router) {
+    const buildPath = getBuildPath()
+
+    router.group(this.angularRouteGroupName, group => {
+      group.match('/service-worker.js', ({ serviceWorker }) => {
+        serviceWorker(`dist/__edgio__/service-worker.js`)
+      })
+      group.match('/assets/:path*', ({ cache, serveStatic }) => {
+        cache(PUBLIC_CACHE_CONFIG)
+        serveStatic(`${buildPath}/assets/:path`)
+      })
+      group.static(buildPath, {
+        handler: () => res => res.cache(PUBLIC_CACHE_CONFIG),
+        glob: `*`,
+      })
+
+      // we can determine SSR support by whether or not a server output path exists
+      const isSsr = !!getOutputPath('server')
+
+      if (isSsr) {
+        group.match('/:path*', async ({ proxy }) => {
+          proxy(BACKENDS.js)
+        })
+      } else {
+        group.match(
+          '/:path*',
+          async ({ serveStatic }) =>
+            await serveStatic(`${buildPath}/:path*`, {
+              onNotFound: async () => await serveStatic(`${buildPath}/index.html`),
+            })
+        )
+      }
+    })
+  }
+}

edgio-angular-connector/src/router/AngularRoutes.ts

@@ -0,0 +1,3 @@
+import AngularRoutes from './AngularRoutes'
+
+export const angularRoutes = new AngularRoutes()

edgio-angular-connector/src/router/index.ts

@@ -0,0 +1,32 @@
+import { join } from 'path'
+import nonWebpackRequire from '@edgio/core/utils/nonWebpackRequire'
+
+/**
+ * Gets the contents of angular.json as an object
+ */
+export function getAngularConfig() {
+  const angularConfigPath = join(process.cwd(), 'angular.json')
+  return nonWebpackRequire(angularConfigPath)
+}
+
+/**
+ * Returns the config for the defaultProject in angularConfig.json,
+ * or the config for env.ANGULAR_PROJECT if defined
+ */
+export function getAngularProject() {
+  const angularConfig = getAngularConfig()
+  return process.env.ANGULAR_PROJECT || angularConfig.defaultProject
+}
+
+/**
+ * Gets the outputPath prop from angular.json for the given project and type under
+ * /projects/<angular-project>/architect/<type>/options
+ */
+export function getOutputPath(type: 'build' | 'server') {
+  const angularConfig = getAngularConfig()
+  const angularProject = getAngularProject()
+
+  return angularConfig.projects[angularProject].architect[type]?.options?.outputPath
+}
+
+export const getBuildPath = () => getOutputPath('build')