feat: dynamic import retry plugin [KM-865] #2

2eha0 · 2025-01-07T07:36:00Z

Summary

add dynamic import retry plugin
add e2e tests and vitest settings
modified CI to support playwright caches

adamdehaven

I left an initial review; the biggest issue is please back out the changes turning this into a mono repo.

Separately, it would be great if you could please extensively comment the code so that maintenance and future updates are easier.

adamdehaven · 2025-01-07T14:35:49Z

package.json

+    "test-build": "VITE_TEST_BUILD=1 vitest run -c vitest.config.e2e.ts",
+    "debug-serve": "VITE_DEBUG_SERVE=1 vitest run -c vitest.config.e2e.ts",


question: I'm not sure I understand the multiple test commands here

debug-* are not necessary, removed

playground/vitestGlobalSetup.ts

adamdehaven · 2025-01-07T14:37:53Z

playground/vitestSetup.ts

@@ -0,0 +1,350 @@
+import type * as http from 'node:http'


question: I believe most of this was taken from one of the existing vite repos. Are we actually using the entirety of the config or is there any unneeded code here for our purpose?

I removed most of code that I thought they were not necessary for us.

adamdehaven · 2025-01-07T14:39:07Z

playground/vue/.gitignore

@@ -0,0 +1,24 @@
+# Logs


question: is there a reason this ignore logic can't be in the root .gitignore? (We wouldn't want to ignore .vscode/

adamdehaven · 2025-01-07T14:40:00Z

playground/vitestSetup.ts

+
+export const workspaceRoot = resolve(__dirname, '../')
+
+export const isBuild = !!process.env.VITE_TEST_BUILD


Please explain the env variables used in the file

comments added

adamdehaven · 2025-01-07T14:40:49Z

playground/vue/package.json

+{
+  "name": "@kong-vite-plugin/vue",
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "dev": "vite",
+    "build": "vue-tsc -b && vite build",
+    "preview": "vite preview"
+  },
+  "dependencies": {
+    "vue": "^3.5.13",
+    "vue-router": "^4.5.0"
+  },
+  "devDependencies": {
+    "@vitejs/plugin-vue": "^5.2.1",
+    "@vue/tsconfig": "^0.7.0",
+    "vue-tsc": "^2.2.0"
+  }
+}


issue: why does the playground need its own package.json file? This isn't a monorepo. Please move dependencies to the root

We can create multiple projects under the playground folder, package.json for each one is necessary, otherwise, how can we manually run those demo projects from the root level?

Can you please write up how you envision the testing working?

I’m not sure it makes sense to have fully-standalone applications for testing purposes.

If we need to change to a mono repository then I’d first want to restructure things before merging this PR

If each package is independent and needs an entire app sandbox I’d almost rather delete this repository and just utilize public-ui-components instead; it’s already set up and would essentially just need a different build command.

For dependencies in the current structure, playground dependencies would be devDependencies in the root package.json

My initial thought was that we might need multiple applications to test different cases, similar to https://github.com/vitejs/vite-plugin-vue/tree/main/playground.

However, we can start simple by writing all use cases in a single project. If more complex scenarios arise, we can refactor it into a monorepo as needed.

adamdehaven · 2025-01-07T14:47:17Z

playground/vue/tsconfig.json

@@ -0,0 +1,24 @@
+{
+  "compilerOptions": {


question: why does the playground need its own tsconfig? Can it just extend the one from the root?

adamdehaven · 2025-01-07T14:47:38Z

pnpm-workspace.yaml

+packages:
+  - 'playground/**'


issue: this should not be a monorepo, please remove

adamdehaven · 2025-01-07T14:48:43Z

src/plugin-dynamic-import-retry/import-wrapper.ts

+  /*
+  Copyright 2024 Carl-Erik Kopseng
+
+  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+  */


is this a requirement of an external lib? If yes, can you please add a link to the source?

Also, could this be extracted into its own file and imported where needed rather than inlined into our code?

link added.

No, the code in this function shouldn't have external references, I put detailed reason in comments.

adamdehaven · 2025-01-07T23:07:14Z

.github/actions/setup-pnpm-with-dependencies/action.yaml

+      run: echo "PLAYWRIGHT_BROWSERS_PATH=$HOME/.cache/playwright-bin" >> $GITHUB_ENV
+
+    - name: Cache Playwright's binary
+      uses: actions/cache@v4
+      with:
+        key: playwright-bin-v1
+        path: ${{ env.PLAYWRIGHT_BROWSERS_PATH }}


suggestion: It would be preferred to give the step an id, output via $GITHUB_OUTPUT, and then reference the step output below where needed

CLAassistant · 2025-01-08T03:10:15Z

All committers have signed the CLA.

adamdehaven

Left some initial feedback.

There is a large lack of comments in the code that would be helpful for review. Please thoroughly comment the code.

adamdehaven · 2025-01-10T02:58:45Z

.github/actions/setup-pnpm-with-dependencies/action.yaml

+      id: playwright-cache
+      uses: actions/cache@v4
+      with:
+        key: playwright-bin-v1


Should we tie the cache key here to a dynamic string that includes the playwright dependency version from package.json?

adamdehaven · 2025-01-10T02:59:33Z

.gitignore

@@ -20,3 +20,6 @@ dist

 # Local History
 .history
+


I believe some additional playwright artifact paths will need to be added

adamdehaven · 2025-01-10T03:02:57Z

playground/dynamic-import-retry/vue-router/src/vite-env.d.ts

@@ -0,0 +1 @@
+/// <reference types="vite/client" />


I believe we can remove this file and reference the types in the tsConfig

adamdehaven · 2025-01-10T03:03:26Z

playground/dynamic-import-retry/vue-router/tsconfig.json

+    "baseUrl": ".",
+    "outDir": "dist",
+    "declaration": false,
+    "declarationDir":null


Suggested change

"declarationDir":null

"declarationDir": null

adamdehaven · 2025-01-10T03:04:54Z

src/plugin-dynamic-import-retry/import-wrapper.ts

+  const identity = (e: any) => e
+  const retry = createDynamicImportWithRetry(options.retries)
+
+  /*


Which part of this file is from the external reference? Can we move the copyright and the code into a separate file, add a URL from where the code was sourced from, and import here where needed?

2eha0 force-pushed the feat/dynmamic-import-retry branch 7 times, most recently from a527f90 to 77c17e6 Compare January 7, 2025 08:30

feat: dynamic import retry plugin [KM-865]

9ddda00

2eha0 force-pushed the feat/dynmamic-import-retry branch from 77c17e6 to 9ddda00 Compare January 7, 2025 08:37

adamdehaven reviewed Jan 7, 2025

View reviewed changes

fix: review issues

96fd000

2eha0 added 3 commits January 8, 2025 15:09

fix: review issues

5d1fbb5

fix: tests

5042a73

refactor: tests

73dc74e

2eha0 force-pushed the feat/dynmamic-import-retry branch from c0a326e to 73dc74e Compare January 9, 2025 09:41

2eha0 added 2 commits January 9, 2025 18:04

docs: tests

b87ef41

docs: tests

5afe05b

adamdehaven requested changes Jan 10, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: dynamic import retry plugin [KM-865] #2

feat: dynamic import retry plugin [KM-865] #2

2eha0 commented Jan 7, 2025 •

edited by jira bot

Loading

adamdehaven left a comment

adamdehaven Jan 7, 2025

2eha0 Jan 8, 2025

adamdehaven Jan 7, 2025

2eha0 Jan 8, 2025

adamdehaven Jan 7, 2025

2eha0 Jan 8, 2025

adamdehaven Jan 7, 2025

2eha0 Jan 8, 2025

adamdehaven Jan 7, 2025

2eha0 Jan 8, 2025

adamdehaven Jan 8, 2025

adamdehaven Jan 8, 2025

2eha0 Jan 8, 2025

adamdehaven Jan 7, 2025

2eha0 Jan 8, 2025

adamdehaven Jan 7, 2025

2eha0 Jan 8, 2025

adamdehaven Jan 7, 2025 •

edited

Loading

2eha0 Jan 8, 2025

adamdehaven Jan 7, 2025

2eha0 Jan 8, 2025

CLAassistant commented Jan 8, 2025 •

edited

Loading

adamdehaven left a comment

adamdehaven Jan 10, 2025

adamdehaven Jan 10, 2025

adamdehaven Jan 10, 2025

adamdehaven Jan 10, 2025

adamdehaven Jan 10, 2025

		"test-build": "VITE_TEST_BUILD=1 vitest run -c vitest.config.e2e.ts",
		"debug-serve": "VITE_DEBUG_SERVE=1 vitest run -c vitest.config.e2e.ts",


		export const workspaceRoot = resolve(__dirname, '../')

		export const isBuild = !!process.env.VITE_TEST_BUILD

		packages:
		- 'playground/**'

feat: dynamic import retry plugin [KM-865] #2

Are you sure you want to change the base?

feat: dynamic import retry plugin [KM-865] #2

Conversation

2eha0 commented Jan 7, 2025 • edited by jira bot Loading

Summary

adamdehaven left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

adamdehaven Jan 7, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

CLAassistant commented Jan 8, 2025 • edited Loading

adamdehaven left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

2eha0 commented Jan 7, 2025 •

edited by jira bot

Loading

adamdehaven Jan 7, 2025 •

edited

Loading

CLAassistant commented Jan 8, 2025 •

edited

Loading