## Description
- Implement Etag caching for consolidated api in view mode.
- Generate Etag for consolidated api in view mode
- compare the if none match header with the computed etag and respond
with either a 304 or 200
- add span for generate etag fn
- Remove prefetching and caching of static assets in service worker
```mermaid
sequenceDiagram
Client->>Server: Request Consolidated API
Server-->>Server: Compute ETag
Server-->>Client: Respond with ETag, Cache-Control
Client->>Server: Subsequent Request with If-None-Match
alt ETag Matches
Server-->>Client: 304 Not Modified
else ETag Different
Server-->>Client: Full Response with New ETag
end
```
## Automation
/ok-to-test tags="@tag.All"
### 🔍 Cypress test results
<!-- This is an auto-generated comment: Cypress test results -->
> [!TIP]
> 🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
> Workflow run:
<https://github.com/appsmithorg/appsmith/actions/runs/13046610688>
> Commit: c14d58da8a59b3bbfb10c7e308b518d2cd8e3b7d
> <a
href="https://internal.appsmith.com/app/cypress-dashboard/rundetails-65890b3c81d7400d08fa9ee5?branch=master&workflowId=13046610688&attempt=1"
target="_blank">Cypress dashboard</a>.
> Tags: `@tag.All`
> Spec:
> <hr>Thu, 30 Jan 2025 07:14:21 UTC
<!-- end of auto-generated comment: Cypress test results -->
## Communication
Should the DevRel and Marketing teams inform users about this change?
- [ ] Yes
- [x] No
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
- **New Features**
- Added ETag support for consolidated API responses to improve caching
efficiency.
- Introduced a new route handler for the `/api/v1/consolidated-api/view`
endpoint.
- **Performance Improvements**
- Optimized NGINX configuration for API responses.
- Updated tracing endpoint for better monitoring.
- **Dependency Updates**
- Added Jackson datatype support for Java 8 date and time handling.
- **Technical Enhancements**
- Improved request handling in ConsolidatedAPIController.
- Updated service worker configuration.
- Refined feature flag handling in the client.
- Enhanced API request headers for consolidated page load functions.
- Simplified caching and routing logic in the service worker.
- Adjusted service worker caching strategy for production environment.
- Updated test specification path for Cypress limited tests.
- Modified request handling to remove unnecessary headers in feature
flag functions.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
104 lines
3.6 KiB
JavaScript
104 lines
3.6 KiB
JavaScript
/* eslint-disable @typescript-eslint/no-var-requires */
|
||
const { merge } = require("webpack-merge");
|
||
const common = require("./craco.common.config.js");
|
||
const WorkboxPlugin = require("workbox-webpack-plugin");
|
||
const CompressionPlugin = require("compression-webpack-plugin");
|
||
const { RetryChunkLoadPlugin } = require("webpack-retry-chunk-load-plugin");
|
||
const FaroSourceMapUploaderPlugin = require("@grafana/faro-webpack-plugin");
|
||
const path = require("path");
|
||
|
||
const env = process.env.REACT_APP_ENVIRONMENT;
|
||
const isAirgap = process.env.REACT_APP_AIRGAP_ENABLED;
|
||
const plugins = [];
|
||
|
||
plugins.push(
|
||
new WorkboxPlugin.InjectManifest({
|
||
swSrc: "./src/serviceWorker.ts",
|
||
mode: "production",
|
||
swDest: "./pageService.js",
|
||
exclude: [
|
||
// Don’t cache source maps and PWA manifests.
|
||
// (These are the default values of the `exclude` option: https://developer.chrome.com/docs/workbox/reference/workbox-build/#type-WebpackPartial,
|
||
// so we need to specify them explicitly if we’re extending this array.)
|
||
/\.map$/,
|
||
/^manifest.*\.js$/,
|
||
// Don’t cache the root html file
|
||
/index\.html/,
|
||
// Don’t cache LICENSE.txt files emitted by CRA
|
||
// when a chunk includes some license comments
|
||
/LICENSE\.txt/,
|
||
// Don’t cache static icons as there are hundreds of them, and caching them all
|
||
// one by one (as the service worker does it) keeps the network busy for a long time
|
||
// and delays the service worker installation
|
||
/\/*\.svg$/,
|
||
/\.(js|css|html|png|jpg|jpeg|gif)$/, // Exclude JS, CSS, HTML, and image files
|
||
],
|
||
}),
|
||
);
|
||
|
||
if (env === "PRODUCTION") {
|
||
plugins.push(
|
||
new FaroSourceMapUploaderPlugin({
|
||
appId: process.env.REACT_APP_FARO_APP_ID,
|
||
appName: process.env.REACT_APP_FARO_APP_NAME,
|
||
endpoint: process.env.REACT_APP_FARO_SOURCEMAP_UPLOAD_ENDPOINT,
|
||
stackId: process.env.REACT_APP_FARO_STACK_ID,
|
||
// instructions on how to obtain your API key are in the documentation
|
||
// https://grafana.com/docs/grafana-cloud/monitor-applications/frontend-observability/sourcemap-upload-plugins/#obtain-an-api-key
|
||
apiKey: process.env.REACT_APP_FARO_SOURCEMAP_UPLOAD_API_KEY,
|
||
gzipContents: true,
|
||
}),
|
||
);
|
||
}
|
||
|
||
plugins.push(
|
||
new CompressionPlugin({
|
||
algorithm: "brotliCompress",
|
||
filename: "[path][base].br",
|
||
test: /\.(js|css|html|svg)$/,
|
||
threshold: 10240,
|
||
minRatio: 0.8,
|
||
}),
|
||
);
|
||
|
||
plugins.push(
|
||
new RetryChunkLoadPlugin({
|
||
// optional value to set the amount of time in milliseconds before trying to load the chunk again. Default is 0
|
||
retryDelay: 3000,
|
||
// optional value to set the maximum number of retries to load the chunk. Default is 1
|
||
maxRetries: 2,
|
||
// optional code to be executed in the browser context if after all retries chunk is not loaded.
|
||
// if not set - nothing will happen and error will be returned to the chunk loader.
|
||
lastResortScript: "window.location.href='/404.html';",
|
||
}),
|
||
);
|
||
|
||
module.exports = merge(common, {
|
||
babel: {
|
||
plugins: ["babel-plugin-lodash"],
|
||
loaderOptions: {
|
||
cacheDirectory: false,
|
||
},
|
||
},
|
||
webpack: {
|
||
configure: {
|
||
devtool: env === "PRODUCTION" ? "source-map" : false,
|
||
plugins,
|
||
},
|
||
},
|
||
plugins: [
|
||
// Enable Airgap builds
|
||
{
|
||
plugin: {
|
||
overrideWebpackConfig: ({ context: { env, paths }, webpackConfig }) => {
|
||
if (env.REACT_APP_AIRGAP_ENABLED === "true" || isAirgap === "true") {
|
||
paths.appBuild = webpackConfig.output.path =
|
||
path.resolve("build_airgap");
|
||
}
|
||
return webpackConfig;
|
||
},
|
||
},
|
||
},
|
||
],
|
||
});
|