Merge pull request #28 from kilork/not_found_resolves_to

Not found resolves to default index.html
kilork · Dec 18, 2020 · f9e2760 · f9e2760
2 parents 5107a29 + 6ef1f71
commit f9e2760
Show file tree

Hide file tree

Showing 3 changed files with 96 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -11,6 +11,7 @@ Dual-licensed under `MIT` or the [UNLICENSE](http://unlicense.org/).
 - Install dependencies with [npm](https://npmjs.org) package manager
 - Run custom `npm` run commands (such as [webpack](https://webpack.js.org/))
 - Support for npm-like package managers ([yarn](https://yarnpkg.com/))
+- Support for angular-like routers
 
 ## Usage
 
@@ -61,7 +62,7 @@ use std::collections::HashMap;
 
 include!(concat!(env!("OUT_DIR"), "/generated.rs"));
 
-#[actix_rt::main]
+#[actix_web::main]
 async fn main() -> std::io::Result<()> {
     HttpServer::new(move || {
         let generated = generate();
@@ -70,7 +71,7 @@ async fn main() -> std::io::Result<()> {
         ))
     })
     .bind("127.0.0.1:8080")?
-    .start()
+    .run()
     .await
 }
 ```
@@ -258,7 +259,7 @@ use std::collections::HashMap;
 
 include!(concat!(env!("OUT_DIR"), "/generated.rs"));
 
-#[actix_rt::main]
+#[actix_web::main]
 async fn main() -> std::io::Result<()> {
     HttpServer::new(move || {
         let generated = generate();
@@ -326,3 +327,33 @@ fn main() {
         .build().unwrap();
 }
 ```
+
+### Use-case #5: Angular-like applications
+
+If you are using Angular as frontend, you may want to resolve all not found calls via `index.html` of frontend app. To do this just call method `resolve_not_found_to_root` after resource creation.
+
+```rust
+use actix_web::{App, HttpServer};
+use actix_web_static_files;
+
+use std::collections::HashMap;
+
+include!(concat!(env!("OUT_DIR"), "/generated.rs"));
+
+#[actix_web::main]
+async fn main() -> std::io::Result<()> {
+    HttpServer::new(move || {
+        let generated = generate();
+        App::new().service(actix_web_static_files::ResourceFiles::new(
+            "/", generated,
+        ).resolve_not_found_to_root(),)
+    })
+    .bind("127.0.0.1:8080")?
+    .run()
+    .await
+}
+```
+
+Remember to place you static resources route after all other routes.
+
+You can check complete example [Angular Router Sample](https://github.com/kilork/actix-web-static-files-example-angular-router).
diff --git a/src/impl.rs b/src/impl.rs
@@ -52,6 +52,7 @@ pub struct Resource {
 /// ```
 pub struct ResourceFiles {
     not_resolve_defaults: bool,
+    not_found_resolves_to: Option<String>,
     inner: Rc<ResourceFilesInner>,
 }
 
@@ -60,6 +61,8 @@ pub struct ResourceFilesInner {
     files: HashMap<&'static str, Resource>,
 }
 
+const INDEX_HTML: &str = "index.html";
+
 impl ResourceFiles {
     pub fn new(path: &str, files: HashMap<&'static str, Resource>) -> Self {
         let inner = ResourceFilesInner {
@@ -69,6 +72,7 @@ impl ResourceFiles {
         Self {
             inner: Rc::new(inner),
             not_resolve_defaults: false,
+            not_found_resolves_to: None,
         }
     }
 
@@ -78,6 +82,21 @@ impl ResourceFiles {
         self.not_resolve_defaults = true;
         self
     }
+
+    /// Resolves not found references to this path.
+    ///
+    /// This can be useful for angular-like applications.
+    pub fn resolve_not_found_to<S: ToString>(mut self, path: S) -> Self {
+        self.not_found_resolves_to = Some(path.to_string());
+        self
+    }
+
+    /// Resolves not found references to root path.
+    ///
+    /// This can be useful for angular-like applications.
+    pub fn resolve_not_found_to_root(self) -> Self {
+        self.resolve_not_found_to(INDEX_HTML)
+    }
 }
 
 impl Deref for ResourceFiles {
@@ -111,6 +130,7 @@ impl ServiceFactory for ResourceFiles {
     fn new_service(&self, _: ()) -> Self::Future {
         ok(ResourceFilesService {
             resolve_defaults: !self.not_resolve_defaults,
+            not_found_resolves_to: self.not_found_resolves_to.clone(),
             inner: self.inner.clone(),
         })
         .boxed_local()
@@ -119,6 +139,7 @@ impl ServiceFactory for ResourceFiles {
 
 pub struct ResourceFilesService {
     resolve_defaults: bool,
+    not_found_resolves_to: Option<String>,
     inner: Rc<ResourceFilesInner>,
 }
 
@@ -162,7 +183,7 @@ impl<'a> Service for ResourceFilesService {
             && self.resolve_defaults
             && (req_path.is_empty() || req_path.ends_with("/"))
         {
-            let index_req_path = req_path.to_string() + "index.html";
+            let index_req_path = req_path.to_string() + INDEX_HTML;
             item = self.files.get(index_req_path.as_str());
         }
 
@@ -177,7 +198,14 @@ impl<'a> Service for ResourceFilesService {
             };
 
             let (req, _) = req.into_parts();
-            let item = self.files.get(real_path.as_str());
+
+            let mut item = self.files.get(real_path.as_str());
+
+            if item.is_none() && self.not_found_resolves_to.is_some() {
+                let not_found_path = self.not_found_resolves_to.as_ref().unwrap();
+                item = self.files.get(not_found_path.as_str());
+            }
+
             let response = respond_to(&req, item);
             (req, response)
         };

diff --git a/src/lib.rs b/src/lib.rs
@@ -13,6 +13,7 @@ Dual-licensed under `MIT` or the [UNLICENSE](http://unlicense.org/).
 - Install dependencies with [npm](https://npmjs.org) package manager
 - Run custom `npm` run commands (such as [webpack](https://webpack.js.org/))
 - Support for npm-like package managers ([yarn](https://yarnpkg.com/))
+- Support for angular-like routers
 
 ## Usage
 
@@ -63,7 +64,7 @@ use std::collections::HashMap;
 
 include!(concat!(env!("OUT_DIR"), "/generated.rs"));
 
-#[actix_rt::main]
+#[actix_web::main]
 async fn main() -> std::io::Result<()> {
     HttpServer::new(move || {
         let generated = generate();
@@ -260,7 +261,7 @@ use std::collections::HashMap;
 
 include!(concat!(env!("OUT_DIR"), "/generated.rs"));
 
-#[actix_rt::main]
+#[actix_web::main]
 async fn main() -> std::io::Result<()> {
     HttpServer::new(move || {
         let generated = generate();
@@ -329,6 +330,35 @@ fn main() {
 }
 ```
 
+### Use-case #5: Angular-like applications
+
+If you are using Angular as frontend, you may want to resolve all not found calls via `index.html` of frontend app. To do this just call method `resolve_not_found_to_root` after resource creation.
+
+```rust#ignore
+use actix_web::{App, HttpServer};
+use actix_web_static_files;
+
+use std::collections::HashMap;
+
+include!(concat!(env!("OUT_DIR"), "/generated.rs"));
+
+#[actix_web::main]
+async fn main() -> std::io::Result<()> {
+    HttpServer::new(move || {
+        let generated = generate();
+        App::new().service(actix_web_static_files::ResourceFiles::new(
+            "/", generated,
+        ).resolve_not_found_to_root(),)
+    })
+    .bind("127.0.0.1:8080")?
+    .run()
+    .await
+}
+```
+
+Remember to place you static resources route after all other routes.
+
+You can check complete example [Angular Router Sample](https://github.com/kilork/actix-web-static-files-example-angular-router).
 */
 
 mod r#impl;